Click or drag to resize

Request Class

The Request class represents SIP requests or methods in the protocol, since they request a specific action to be taken by another client or server.
Inheritance Hierarchy
SystemObject
  Independentsoft.SipRequest
    More...

Namespace:  Independentsoft.Sip
Assembly:  Independentsoft.Sip (in Independentsoft.Sip.dll) Version: 1.0.700.17927
Syntax
public class Request

The Request type exposes the following members.

Constructors
  NameDescription
Public methodRequest
Initializes a new instance of the Request class.
Public methodRequest(Dialog)
Initializes a new instance of the Request class from the specified dialog.
Public methodRequest(Response)
Initializes a new instance of the Request class from the specified response.
Public methodRequest(Dialog, SipMethod)
Initializes a new instance of the Request class from the specified dialog.
Public methodRequest(Response, SipMethod)
Initializes a new instance of the Request class from the specified response.
Top
Properties
  NameDescription
Public propertyBody
Gets or sets the request body.
Public propertyBranch
Sets or gets branch parameter in Via header.
Public propertyCallID
Gets or sets Call-ID header field. The Call-ID header field is mandatory in all requests. It is used to uniquely identify a call between two clients. If is not set then the SipClient will set this header.
Public propertyContentLength
Gets o sets Content-Length header field. The Content-Length header field indicates the size of the request body. If no body is present in a request, then the Content-Length header field value must be zero.
Public propertyContentType
Gets or sets Content-Type header field. The Content-Type header field is used to specify the Internet media type in the request body. Media types have the familiar form type/sub-type. If this header field is not present, application/sdp is assumed.
Public propertyCSeq
Gets CSeq header field. The CSeq header field is a required header field in every request. The CSeq header field contains a number that increases for each request. Usually, it increases by 1 for each new request, with the exception of CANCEL and ACK requests, which use the CSeq number of the INVITE request to which it refers.
Public propertyDate
Gets or sets Date header field. The Date header field is used to convey the date when the request is sent.
Public propertyFrom
Gets or sets From header field. The From header field is a required header field that indicates the originator of the request.
Public propertyHeader
Gets the request header.
Public propertyMaxForwards
Gets or sets Max-Forwards header field. The Max-Forwards header field is used to indicate the maximum number of hops that a the request may take. The value of the header field is decremented by each proxy that forwards the request. If is not set then the SipClient will set this header.
Public propertyMethod
Gets the request method.
Public propertySessionDescription
Returns the request body as SessionDescription if Content-Type is "application/sdp", otherwise returns null. Sets request body and sets Content-Type as "application/sdp".
Public propertyTo
Gets or sets To header field. The To header field is a required header field in every request used to indicate the recipient of the request.
Public propertyUri
Gets or sets request URI. It indicates the user or service to which this request is being addressed.
Public propertyVia
Gets or sets Via header field. The Via header field indicates the path taken by the request so far and indicates the path that should be followed in routing responses. The "branch" parameter in the Via header field values serves as a transaction identifier, and is used by proxies to detect loops. The Via header field value contains the transport protocol used to send the message, the client's host name or network address, and possibly the port number at which it wishes to receive responses. The Via header field value can also contain parameters such as "maddr", "ttl", "received" and "branch".
Top
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodStatic memberParse
Converts the specified string representation of a request to its Request equivalent.
Public methodToString
Converts the value of this instance to its equivalent string representation.
(Overrides ObjectToString.)
Top
See Also
Inheritance Hierarchy
SystemObject
  Independentsoft.SipRequest
    Independentsoft.Sip.MethodsAck
    Independentsoft.Sip.MethodsBye
    Independentsoft.Sip.MethodsCancel
    Independentsoft.Sip.MethodsInfo
    Independentsoft.Sip.MethodsInvite
    Independentsoft.Sip.MethodsMessage
    Independentsoft.Sip.MethodsNotify
    Independentsoft.Sip.MethodsOptions
    Independentsoft.Sip.MethodsPrack
    Independentsoft.Sip.MethodsPublish
    Independentsoft.Sip.MethodsRefer
    Independentsoft.Sip.MethodsRegister
    Independentsoft.Sip.MethodsSubscribe
    Independentsoft.Sip.MethodsUpdate